/*!
  \file
  Header file for HDF5 'helper' class for HHVolume
*/


/*
  Copyright (c) 2011, President & Fellows of Harvard College
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  * Neither the name of the Harvard College nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef SCIGPU_HHV_HHV_H5_HELPER_HPP
#define SCIGPU_HHV_HHV_H5_HELPER_HPP

#include <stdexcept>

#include "H5Cpp.h"


namespace SciGPU {
  namespace HHV {
    
    //! Class to help with HDF 5 datatypes
    /*!
      The purpose of this class is to turn a template
      parameter into an \c H5::DataType object.
      This is necessary because the HDF5 I/O methods
      for the HHVolume class are templated, whereas
      the HDF5 routines are not.
    */
    template<typename T>
    class HHVH5 {
    public:

      //! Return an H5::DataType based on template parameter
      static H5::DataType GetH5Type( void ) {
        /*!
          This method should be overloaded for each specific
          data type.
          By default, it throws an instance of
          \c std::logic_error
        */
        throw std::logic_error( "Unrecognised HDF5 type" );
        H5::DataType tmp;
        return( tmp );
      }

    private:


    };

    template<>
    H5::DataType HHVH5<float>::GetH5Type( void );

    template<>
    H5::DataType HHVH5<double>::GetH5Type( void );

    template<>
    H5::DataType HHVH5<long>::GetH5Type( void );

  }
}


#endif
